Skip to content

Little fixes and improvements in documentation#279

Open
xlamorlette-datadog wants to merge 9 commits intomainfrom
xlamorlette/documentation-improvements
Open

Little fixes and improvements in documentation#279
xlamorlette-datadog wants to merge 9 commits intomainfrom
xlamorlette/documentation-improvements

Conversation

@xlamorlette-datadog
Copy link
Collaborator

@xlamorlette-datadog xlamorlette-datadog commented Feb 18, 2026

Description

  • Various minor fixes and improvements in the documentation files.
  • Fix bin/format so that it runs locally.
  • Add @DataDog/cpp-reviewers as code owners (to get automatic notifications for PRs).

Motivation

Additional Notes

@pr-commenter
Copy link

pr-commenter bot commented Feb 18, 2026

Benchmarks

Benchmark execution time: 2026-03-16 17:48:43

Comparing candidate commit e4632e0 in PR branch xlamorlette/documentation-improvements with baseline commit 2bbc991 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 1 metrics, 0 unstable metrics.

@codecov-commenter
Copy link

codecov-commenter commented Feb 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.70%. Comparing base (2bbc991) to head (dd0f14c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #279   +/-   ##
=======================================
  Coverage   87.70%   87.70%           
=======================================
  Files          84       84           
  Lines        5668     5668           
=======================================
  Hits         4971     4971           
  Misses        697      697           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@datadog-datadog-prod-us1

This comment has been minimized.

@xlamorlette-datadog xlamorlette-datadog force-pushed the xlamorlette/documentation-improvements branch from e22402a to 482c52d Compare March 13, 2026 17:32
@xlamorlette-datadog xlamorlette-datadog marked this pull request as ready for review March 13, 2026 18:23
@xlamorlette-datadog xlamorlette-datadog requested a review from a team as a code owner March 13, 2026 18:23
@xlamorlette-datadog xlamorlette-datadog requested review from zacharycmontoya and removed request for a team March 13, 2026 18:23
@xlamorlette-datadog xlamorlette-datadog changed the title Little fixes and improvements in general documentation Little fixes and improvements in documentation Mar 13, 2026
README.md Outdated

Code coverage reports are available [here][2].
Code coverage reports, run on pull requests, are available
[in Datadog](https://app.datadoghq.com/ci/code-coverage/github.com%2Fdatadog%2Fdd-trace-cpp/pull-requests).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is not publicly accessible, whereas the previous one was. We should probably leave that link as-is for now

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put the link in our internal 'APM C++' Confluence page.

process_arg "$arg"
done | xargs -0 \
docker run \
--platform linux/amd64 \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have an arm64 machine to test if this will still work for an Apple Silicon dev environment?

Copy link
Collaborator Author

@xlamorlette-datadog xlamorlette-datadog Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I introduced this so that it works on my MacBook M3, because the used silkeh/clang:14 Docker image doesn't exist for arm64, it only exists for amd64. I'm going to add a comment about this.
This --platform option of docker run forces the usage of an amd64 image from an arm64 machine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants